feat: enhance CLI help messages with comprehensive documentation#19
Merged
Conversation
inureyes
added a commit
that referenced
this pull request
Aug 27, 2025
inureyes
added a commit
that referenced
this pull request
Aug 27, 2025
* fix: use parallel config value from configuration file
Previously, the parallel setting in config files was completely ignored.
This fix implements proper config support for the parallel option:
- Add get_parallel() method to Config struct (follows same pattern as get_timeout)
- Add parallel field to ClusterDefaults struct
- Check if user explicitly specified -p/--parallel in CLI args
- Use config value when CLI option not explicitly provided
- Priority: CLI (if explicit) > Cluster config > Global defaults > CLI default (10)
Now users can set parallel in their config files:
defaults:
parallel: 50
clusters:
production:
parallel: 100
Fixes the issue where config parallel values were defined but never used.
* chore: prepare release v0.5.4
* update: help documents (#19)
inureyes
added
priority:low
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enhanced all CLI help messages to provide comprehensive documentation directly in the terminal, matching the detail level of the manpage documentation.
Changes
after_helpsectionsImpact
Users now have access to complete usage information directly from
--helpwithout needing to refer to external documentation. This significantly improves the user experience and makes the tool more self-documenting.Test Results
All help messages have been tested and render correctly: